package com.ruoyi.system.domain.vo;

import com.fasterxml.jackson.annotation.JsonInclude;

import java.util.List;

/**
 * 路由配置信息 VO 类，用于表示前端路由的结构化数据。
 * 包含路由的基本属性、元信息以及子路由列表等字段。
 *
 * @author ruoyi
 */
@JsonInclude(JsonInclude.Include.NON_EMPTY)
public class RouterVo {
    /**
     * 路由名字
     */
    private String name;

    /**
     * 路由地址
     */
    private String path;

    /**
     * 是否隐藏路由，当设置 true 的时候该路由不会再侧边栏出现
     */
    private boolean hidden;

    /**
     * 重定向地址，当设置 noRedirect 的时候该路由在面包屑导航中不可被点击
     */
    private String redirect;

    /**
     * 组件地址
     */
    private String component;

    /**
     * 路由参数：如 {"id": 1, "name": "ry"}
     */
    private String query;

    /**
     * 当你一个路由下面的 children 声明的路由大于1个时，自动会变成嵌套的模式--如组件页面
     */
    private Boolean alwaysShow;

    /**
     * 其他元素（如标题、图标、权限标识等）
     */
    private MetaVo meta;

    /**
     * 子路由列表
     */
    private List<RouterVo> children;

    /**
     * 获取路由名称
     *
     * @return 路由名称
     */
    public String getName() {
        return name;
    }

    /**
     * 设置路由名称
     *
     * @param name 路由名称
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * 获取路由路径
     *
     * @return 路由路径
     */
    public String getPath() {
        return path;
    }

    /**
     * 设置路由路径
     *
     * @param path 路由路径
     */
    public void setPath(String path) {
        this.path = path;
    }

    /**
     * 获取是否隐藏路由的状态
     *
     * @return 隐藏状态，true 表示隐藏
     */
    public boolean getHidden() {
        return hidden;
    }

    /**
     * 设置是否隐藏路由
     *
     * @param hidden 隐藏状态，true 表示隐藏
     */
    public void setHidden(boolean hidden) {
        this.hidden = hidden;
    }

    /**
     * 获取重定向地址
     *
     * @return 重定向地址
     */
    public String getRedirect() {
        return redirect;
    }

    /**
     * 设置重定向地址
     *
     * @param redirect 重定向地址
     */
    public void setRedirect(String redirect) {
        this.redirect = redirect;
    }

    /**
     * 获取组件地址
     *
     * @return 组件地址
     */
    public String getComponent() {
        return component;
    }

    /**
     * 设置组件地址
     *
     * @param component 组件地址
     */
    public void setComponent(String component) {
        this.component = component;
    }

    /**
     * 获取路由参数字符串
     *
     * @return 路由参数 JSON 字符串
     */
    public String getQuery() {
        return query;
    }

    /**
     * 设置路由参数字符串
     *
     * @param query 路由参数 JSON 字符串
     */
    public void setQuery(String query) {
        this.query = query;
    }

    /**
     * 获取 alwaysShow 状态，决定是否始终显示根级路由
     *
     * @return alwaysShow 状态
     */
    public Boolean getAlwaysShow() {
        return alwaysShow;
    }

    /**
     * 设置 alwaysShow 状态
     *
     * @param alwaysShow alwaysShow 状态
     */
    public void setAlwaysShow(Boolean alwaysShow) {
        this.alwaysShow = alwaysShow;
    }

    /**
     * 获取路由元信息对象
     *
     * @return 元信息对象
     */
    public MetaVo getMeta() {
        return meta;
    }

    /**
     * 设置路由元信息对象
     *
     * @param meta 元信息对象
     */
    public void setMeta(MetaVo meta) {
        this.meta = meta;
    }

    /**
     * 获取子路由列表
     *
     * @return 子路由列表
     */
    public List<RouterVo> getChildren() {
        return children;
    }

    /**
     * 设置子路由列表
     *
     * @param children 子路由列表
     */
    public void setChildren(List<RouterVo> children) {
        this.children = children;
    }
}
